home *** CD-ROM | disk | FTP | other *** search
/ HAKERIS 11 / HAKERIS 11.ISO / soft / development / Macromedia RoboHelp X5 / RoboHelpOffice.exe / Data1.cab / _111B2FAA1D55488DA063A4850FBF486E < prev    next >
Encoding:
Text File  |  2003-12-19  |  4.0 KB  |  89 lines
  1. /***************************************************************************************** 
  2.    Context-Sensitive-Help API for RoboHelp, WebHelp, WebHelp Enterprise
  3.    Macromedia
  4.    Copyright⌐ 1998-2004 eHelp« Corporation.All rights reserved.
  5.  
  6. *****************************************************************************************
  7.  
  8.      Syntax:
  9.      int RH_ShowHelp(HWND hParent, const char * a_pszHelpFile, unsigned int uCommand, DWORD dwData)
  10.  
  11.      hParent
  12.           Handle to the parent window. This is currently reserved for future versions of the API.
  13.           Can be a window handle or 0.
  14.  
  15.      a_pszHelpFile
  16.           WebHelp:
  17.                Path to help system start page ("http://www.myurl.com/help/help.htm" or "/help/help.htm")
  18.                For custom windows (defined in Help project), add ">" followed by the window name ("/help/help.htm>mywin")
  19.  
  20.           WebHelp Enterprise:
  21.                Path to RoboEngine server ("http://RoboEngine/roboapi.asp")
  22.                If automatic merging is turned off in RoboEngine Configuration Manager, specify the project name in the URL ("http://RoboEngine/roboapi.asp?project=myproject")
  23.                For custom windows (defined in Help project), add ">" followed by the window name ("http://RoboEngine/roboapi.asp>mywindow")
  24.  
  25.      uCommand
  26.           Command to display help. One of the following:
  27.                     HH_HELP_CONTEXT     ' Displays the topic associated with the Map ID sent in dwData
  28.                                         if 0, then default topic is displayed.
  29.                The following display the default topic and the Search, Index, or TOC pane.
  30.                Note: The pane displayed in WebHelp Enterprise will always be the window's default pane.
  31.                     HH_DISPLAY_SEARCH
  32.                     HH_DISPLAY_INDEX
  33.                     HH_DISPLAY_TOC
  34.  
  35.      dwData
  36.           Map ID associated with the topic to open (if using HH_HELP_CONTEXT), otherwise 0
  37.  
  38.      Examples:
  39.           RH_ShowHelp(GetSafeHwnd(), "http://www.myurl.com/help/help.htm", HH_HELP_CONTEXT, (DWORD)10);
  40.           RH_ShowHelp(GetSafeHwnd(), "C:\Program Files\MyApp\help\help.htm", HH_HELP_CONTEXT, (DWORD)100);
  41.  
  42. **********************************************************
  43.      To use airplane help, you will need to associate offline help before any help calls are made.
  44.      Once associated, help calls will use the primary help when an internet connection is present, otherwise they will fall back on the local help.
  45.  
  46.      Syntax:
  47.      void RH_AssociateOfflineHelp(const char * a_pszPrimaryHelpSource, const char * a_pszBackupHelpSource)
  48.  
  49.      Examples:
  50.           RH_AssociateOfflineHelp("http://RoboEngine/roboapi.asp?project=MyAppHelp", "C:\Program Files\MyApp\help\help.htm");  // Associates WebHelp Enterprise and local WebHelp
  51.           RH_AssociateOfflineHelp("http://www.myurl.com/help/help.htm>MyWebHelpWindow", "C:\Program Files\MyApp\help.chm>MyHTMLHelpWindow"); // Associates remote WebHelp and local HTML Help (specifying windows)
  52.  
  53. ******************************************************************************************/
  54.  
  55. #ifndef ROBOHELP_CSH_H
  56. #define ROBOHELP_CSH_H
  57.  
  58. //   RH_AssociateOfflineHelp
  59. //        [in] a_pszPrimaryHelpSource        - primary server-based help system
  60. //        [in] a_pszBackupHelpSource        - backup help system
  61. #ifdef __cplusplus
  62. extern "C"
  63. {
  64. #endif
  65. void RH_AssociateOfflineHelp(const TCHAR * a_pszPrimaryHelpSource, 
  66.                              const TCHAR * a_pszBackupHelpSource);
  67. #ifdef __cplusplus
  68. }
  69. #endif
  70.  
  71. //   RH_ShowHelp
  72. //        [in] hwndParent        - window handle to the parent window.
  73. //        [in] a_pszHelpFile    - help file name or url to server-based help system
  74. //        [in] uCommand        - pre-defined command used based on the help file
  75. //        [in] dwData            - extra data based on the uCommand parameter specified
  76. //        The return value is    0 for a successful result and non-zero if an error occurs.
  77. #ifdef __cplusplus
  78. extern "C"
  79. {
  80. #endif
  81. int RH_ShowHelp(HWND hParent,
  82.                 const TCHAR * a_pszHelpFile,
  83.                 unsigned int uCommand,
  84.                 DWORD dwData);
  85. #ifdef __cplusplus
  86. }
  87. #endif
  88.  
  89. #endif // ROBOHELP_CSH_H